home *** CD-ROM | disk | FTP | other *** search
/ SPACE 2 / SPACE - Library 2 - Volume 1.iso / apps / 610 / bdb13 / bdb13.doc < prev    next >
Text File  |  1992-06-21  |  18KB  |  477 lines
  1.                            Book DataBase One
  2.                            version one.three
  3.  
  4.                   by Timothy Early, Copyright 1990,1992
  5.                            All rights reserved
  6.  
  7.                         Medium or High Resolution
  8.  
  9. PURPOSE:
  10.  
  11.       To provide an efficient and convenient method of cataloguing
  12. and listing my books.  Entry to be as painless as possible.  All data
  13. is stored in memory for speed of sorting and access.  ASCII listings in
  14. various formats to disk for later printing by the most appropriate
  15. means.  (I use the shareware "2columns.prg") Standard GEM protocols 
  16. (mouse, menus, dialogs) for ease of learning and use.  Slightly
  17. relational  for compactness of internal data representation.  Up to
  18. four authors per title.
  19.  
  20.  
  21. PACKING LIST:
  22.  
  23.       The distribution archive contains the following files:
  24.  
  25.                BDBnn.PRG      -- Main Program File
  26.                BDBnnMED.RSC   -- Medium Resolution Resource File
  27.                BDBnnHI.RSC    -- High Resolution Resource File
  28.                BDBnn.DOC      -- This File
  29.                CHANGEnn.TXT   -- Version notes and customization info.
  30.  
  31.             CONV13.ARC:
  32.                CONV13.GFA     -- Data file conversion program for
  33.                                  upgrading from pre- 1.3 versions.
  34.                CONV13.DOC     -- Instructions to use CONV13.GFA
  35.  
  36.             BDBDESK.ARC:
  37.                BDBDESK.RSC    -- Med and High res icons for desktop.
  38.                BDBDESK.DFN    -- RCS definition for BDBDESK.RSC.
  39.                BDBDESK.NIC    -- NeoDesk 3 format icons.
  40.                BDBDESK.DOC    -- Information file for above.
  41.  
  42.  
  43. COPYING AND DISTRIBUTION:
  44.  
  45.       This version of the Book DataBase is being released as freeware.
  46. No monetary payment is solicited or expected for your use of the program,
  47. so use it and enjoy!  You may copy and distribute the program freely, but
  48. please keep the necessary files (program, resources, and this documentation)
  49. together and unaltered.  This program may NOT be sold for profit without
  50. the author's written permission.
  51.  
  52.       Your comments and suggestions, however, are solicited, and would be
  53. most welcome.  I can be reached by U.S. Mail at:
  54.                          975 Diamond St.
  55.                          San Diego, CA  92109
  56.  
  57.  
  58.  
  59. WARRANTY:
  60.  
  61.       There is none.  Please be assured that I have done everything in
  62. my power to ensure that this program will work correctly, will not eat
  63. your disks or fry your CPU.  However, wiser heads have suggested that
  64. I include a standard disclaimer.  So, in legalese:
  65.  
  66. This program and manual are distributed "AS IS", without warranty as to
  67. it's performance.  The entire risk as to the quality and performance is
  68. assumed by the user.
  69. THERE IS NO WARRANTY OF MERCHANTABILITY, NO WARRANTY OF FITNESS FOR A
  70. PARTICULAR USE, AND NO WARRANTY OF ANY OTHER KIND, EXPRESS, IMPLIED, OR
  71. STATUTORY.  IN NO EVENT WILL THE AUTHOR BE LIABLE TO YOU OR ANYONE ELSE
  72. FOR INDIRECT, SPECIAL, OR CONSEQUENTIAL DAMAGES, SUCH AS, BUT NOT LIMITED
  73. TO, LOSS OF ANTICIPATED PROFITS OR BENEFITS RESULTING FROM THE USE OF
  74. THIS PROGRAM.  SOME STATES DO NOT ALLOW THE EXCLUSION OR LIMITATION OF
  75. INCIDENTAL OR CONSEQUENTIAL DAMAGES, THUS THE ABOVE LIMITATION MAY NOT
  76. APPLY TO YOU.
  77.  
  78.  
  79. INSTRUCTIONS FOR USE:
  80.  
  81.       The program, resource file(s), and data files (when created) must
  82. be in the same directory.  Adequate space must be available for data
  83. and report files.
  84.  
  85.       > When a updated data file is written to disk, the updated file
  86.       > is written with the extender [.$$$].  If there are no errors
  87.       > in the save procedure, the old file is deleted, and the
  88.       > updated file is renamed with the [.BDB] extender.  Keep this
  89.       > in mind when judging disk space.
  90.  
  91.       When you run the program the first time, you will see an alert
  92. telling you that the program could not find the data files.  Click on
  93. "CREATE" to make the empty data files 'AUTHORS.BDB', 'SERIES.BDB', and
  94. 'BOOKS.BDB'.  You will now be taken to the main program screen, with a
  95. GEM menu bar at the top.  Most menu options have a control or an
  96. alternate key equivalent.  The [^] symbol is for a control-key
  97. combination, and the box symbol is for an alternate-key combination.
  98.  
  99.      > Note for Monochrome users:  The monochrome version of the Quick
  100.      > ST Demo 2.0 seems to have a bug and will not allow v_gtext to
  101.      > output a vertically clipped character.  This affects the redraw
  102.      > of the Report and Help windows when a dialog or desk accessory
  103.      > has been superimposed.
  104.  
  105.      > Quick ST 3 does not seem to handle color user defined fill
  106.      > patterns very well.  This causes some cosmetic problems.
  107.  
  108. DESK dropdown:
  109.  
  110.       BOOK DATABASE ONE
  111.       Shows the title dialog; you already saw it at the start of the
  112.       program.  The "DETAILS" button gives you some details of the
  113.       tools I used to write the program.
  114.  
  115.       DESK ACCESSORIES:
  116.       Your desk accessories are all available from the main program
  117.       screen.
  118.  
  119.  
  120. FILE dropdown:
  121.  
  122.       SAVE DATA      [Control-S]
  123.       Saves Authors, Series, or Books data if they have been changed.
  124.       You must explicitly call this function before leaving the
  125.       program to save any changes.
  126.  
  127.       LOAD DATA      [Control-L]
  128.       Loads all three data files; you will lose any changes made since
  129.       your last SAVE.
  130.  
  131.       QUIT           [Control-Q]
  132.       Exit to desktop.  You will be asked for confirmation and warned
  133.       if your data has not been saved.  Selecting this option when
  134.       viewing a report or the help screen will only close that window.
  135.  
  136.  
  137. ENTRY dropdown:
  138.  
  139.       ENTER TITLES...       [Control-E]
  140.       Begins the book entry procedure for a single volume.
  141.  
  142.       REVIEW / EDIT...      [Control-R]
  143.       Review book records, gives you the option to edit a record.
  144.  
  145.       > Each record represents a single 'title', which is usually (but
  146.       > not always) a discrete volume.  (I use two records for an Ace
  147.       > Double novel, for example.)
  148.  
  149.       EDIT AUTHORS      [Control-A]
  150.       EDIT SERIES       [Control-Z]
  151.       Summons the SELECT dialog to edit or delete an author or series.
  152.       Use the DONE button to end.  If you try to delete an author or 
  153.       series which is in use, you will be notified.  Use the REVIEW / 
  154.       EDIT... option to delete the book.
  155.  
  156.       EDIT SUBJECT      [Control-U]
  157.       EDIT CODES        [Control-C]
  158.       Allows you to customize the SUBJECT dialog and the CODE dialog.
  159.       Subject and code strings are stored in the books.bdb file, so when 
  160.       you create a new book file, you must re-customize them.  Changes
  161.       made here will affect each book with that subject or code.
  162.  
  163.  
  164. SORT dropdown:
  165.  
  166.       DO SORT      [Control-D]
  167.       Forces an immediate sort in the order specified by the SELECTed
  168.       option.  Generally never needed.
  169.  
  170.  
  171. SELECT dropdown:
  172.  
  173.       Controls both the order of sort and the format of the output
  174.       book report.  The numbers to the right of the option give a
  175.       rough idea of the depth of the sort.
  176.  
  177.       TITLE        [ALTERNATE-T]
  178.       Sorted by title; Report Format 1.  (see Samples)
  179.  
  180.       AUTHOR       [ALTERNATE-A]
  181.       Sorted by author, and title within author.  Report Format 2.
  182.       (see Samples)
  183.  
  184.       SERIES       [ALTERNATE-S]
  185.       Sorted by author, series, and series sequence number.  Books not
  186.       in a series are sorted by title.  Report Format 3. (see Samples)
  187.  
  188.       SUBJECT      [ALTERNATE-U]
  189.       Sorted by subject and title.  Report Format 1.
  190.  
  191.       BINDING      [ALTERNATE-B]
  192.       Sorted by binding, and title within binding.  Report Format 1.
  193.  
  194.       CODE         [ALTERNATE-C]
  195.       Sorted by code, and then title.  Report Format 1.
  196.  
  197.       NUM1         [ALTERNATE-1]
  198.       Sorted by number field one.  Report Format 1.
  199.  
  200.       NUM2         [ALTERNATE-2]
  201.       Sorted by number field two.  Report Format 1.
  202.  
  203.  
  204. REPORT dropdown:
  205.  
  206.       TO DISK      [ALTERNATE-D]
  207.       Writes a file 'BOOKS_n.TXT' to disk in format defined in SELECT,
  208.       where (n) is replaced by the SELECT letter.
  209.  
  210.       TO WINDOW    [ALTERNATE-W]
  211.       Writes report to a GEM window.  Format is analogous to the disk
  212.       report format, but not the same.
  213.  
  214.       STATISTICS   [question mark]
  215.       Displays a dialog which tells you number of books, authors, and
  216.       series on file.  This information is also printed at the top of
  217.       disk report.  Free memory and maximum number of volumes are also
  218.       displayed.  Maximum numbers of authors and series are the same
  219.       as for volumes.
  220.  
  221.       DETAILED STATS      [ALTERNATE-question mark]
  222.       Writes a report to disk with a more detailed breakdown of data
  223.       statistics.  The filename is STATS.TXT.
  224.  
  225.       WRITE AUTHORS      [ALTERNATE- ]
  226.       Writes alphabetical list of authors to disk file 'AUTHORS.TXT'.
  227.  
  228.       WRITE SERIES       [ALTERNATE- ]
  229.       Writes alphabetical list of series to disk file 'SERIES.TXT'.
  230.  
  231.       EXPORT             [ALTERNATE-X]
  232.       A flattened ASCII file with each field of each record on a
  233.       single line.  If the field is blank, a \n is written.  There are
  234.       eighteen lines per record.  No blank lines are written between
  235.       records.
  236.  
  237.  
  238. HELP dropdown:
  239.  
  240.       HELP      [HELP key]
  241.       Opens a window which contains a short version of this document.
  242.  
  243.  
  244. ENTER A TITLE:
  245.  
  246.       When you select "ENTER TITLE..." you are taken through the entry
  247.       procedure.  The first thing that happens is mandatory fields are
  248.       solicited: Author, Type, Binding and Title.  Following this, optional
  249.       fields may be filled in.  Finally, you can either accept the new
  250.       record or cancel the entry.  The process can only be aborted after
  251.       the mandatory fields are entered.
  252.  
  253.    SELECT AUTHOR dialog:
  254.       This is similar to a file select dialog.  The list of authors appear
  255.       in a scrollable window, with the selected author in a box at the the
  256.       top of the dialog.  The selected author cannot be edited.  Choose
  257.       an author in the window by clicking on it; a double-click will
  258.       "ACCEPT" that author.  The "ACCEPT" button will pass the selected
  259.       author to the entry dialog.
  260.  
  261.       If the desired author is not on the list, click on the "ENTER NEW"
  262.       button.  A dialog will appear to allow you to enter a new author
  263.       name, up to 62 characters.  A very long name will appear truncated
  264.       in subsequent dialogs, but will appear in full on output reports.
  265.  
  266.       > For proper sorting, use the format: LASTNAME, FIRSTNAME
  267.  
  268.       You may edit the selected author by clicking on the name displayed
  269.       in red at the top of the dialog.
  270.  
  271.       The "CLEAR" button will be enabled when it is possible to clear the
  272.       corresponding field in the record.  This option is not available if
  273.       there is only one author specified for a title.
  274.  
  275.       The "CANCEL" button exits the dialog, leaving the original contents
  276.       of the field unchanged.
  277.  
  278.    SUBJECT dialog:
  279.       One of the displayed choices must be selected.
  280.  
  281.    BINDING dialog:
  282.       One of the displayed choices must be selected.
  283.  
  284.       > I tried to account for all common types of binding, so if
  285.       > something is missing, tell me so I can add it.
  286.  
  287.       > Knowing the binding is important to me, as I'll keep differently
  288.       > bound books in different places.
  289.  
  290.       Library bound vs. Book Club:  Many book club hardcover books are
  291.        not bound as well as a 'real' hardcover.  No cloth is used on the
  292.        end boards or spine, a lower quality paper is used, pages are not
  293.        trimmed as well, etc.  Thus, I feel this is a valid distinction
  294.        to make here.
  295.       Trade paperback:  generally, a large-format paperback.
  296.       Paperback: standard formats.
  297.       Spiral Bound:  wire or plastic binding, allows book to lie flat
  298.        when open.
  299.       Binder:  any collection of loose pages between covers, usually
  300.        hole punched for three rings.
  301.  
  302.    ENTRY DIALOG:
  303.  
  304.       TITLE:
  305.       Mandatory field.  Enter up to 60 characters.
  306.  
  307.       > I use a format which puts initial articles last: 
  308.       > "The Complete Sherlock Holmes" becomes "Complete Sherlock Holmes, The"
  309.  
  310.       BY/ED:
  311.       Click here to switch between 'By' (for author) and 'Ed' (for editor).
  312.       '??' disables the corresponding author field (except for primary
  313.       author).
  314.  
  315.       AUTHOR:
  316.       Click when enabled (red border) to enter or change an author.  Calls
  317.       up the "SELECT AUTHOR" dialog.  Use the "BY/ED" field to enable the
  318.       author field.
  319.  
  320.       SERIES:
  321.       Click here to call up the "SELECT SERIES" dialog, which is the same
  322.       as the "SELECT AUTHOR" dialog.  When non-empty, it makes the 
  323.       "SERIES NUMBER" field mandatory.
  324.  
  325.       SERIES NUMBER:
  326.       A three character text entry field for a series sequence number or
  327.       code.  I use letters when I am uncertain of the proper sequence.
  328.  
  329.       SUBJECT:
  330.       Click here to call up the SUBJECT dialog.  Mandatory field.
  331.  
  332.       BINDING:
  333.       Click here to call up the BINDING dialog.  Mandatory field.
  334.  
  335.       CODE:
  336.       Click here to call up the CODE dialog.  Optional field.  This is
  337.       for information which overlaps and supplements the SUBJECT.
  338.  
  339.       NUM 1:
  340.       NUM 2:
  341.       Optional fields for a numeric value between 0-65535.  Can be used
  342.       for an accession number, cover price (assumed decimal), or
  343.       whatever you want.
  344.  
  345.       > Another suggestion for using one of these number fields:
  346.       > Keep a list of people you lend books to; assign each a number.
  347.       > When you loan a book out, update the number field.  Now you can
  348.       > sort and report by the number field, cross reference to your
  349.       > list, and know who has what.
  350.  
  351.       COMMENT1 and COMMENT2:
  352.       Text entry fields for up to 120 characters of free-form comments.
  353.  
  354.  
  355. REVIEW / EDIT PROCEDURE:
  356.  
  357.       When you select the "REVIEW/EDIT..." dropdown you are presented with
  358.       a dialog very similar to the volume entry panel, although the
  359.       individual fields are not selectable.  At the bottom of the panel
  360.       are five buttons and a horizontal slider.  The NEXT and PREVIOUS
  361.       buttons (as well as the areas to the left and right of the slider
  362.       control), will sequentially access the file; using the slider allows
  363.       direct access to any record.
  364.  
  365.    EDIT BOOK button
  366.       Switches to the volume entry panel.  Fields can be selected and
  367.       changed or deleted.  Selecting OKAY or CANCEL will return you to
  368.       the REVIEW/EDIT dialog.
  369.  
  370.    DELETE BOOK Button
  371.       It will ask for confirmation, then delete the book record from
  372.       memory.  BE SURE THIS IS WHAT YOU WANT TO DO!  There is no UNDO
  373.       from this action.  Note that the Author and Series remain on their
  374.       respective lists; they may be in use by another volume.
  375.  
  376.    DONE button
  377.       This button ends the REVIEW/EDIT process.
  378.  
  379.  
  380.  
  381.      
  382. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  383. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  384.  
  385.  
  386.       Sample Reports
  387.  
  388.       > Formats are still being refined.
  389.       > These formats apply to the disk report, the formats in the
  390.       > window will be different, but offer essentially the same
  391.       >information.
  392.  
  393. Report Format 1  ---------------------------------------- 
  394.  
  395. 200 Years to Christmas  -- McIntosh, J. T.
  396. [Widget], the [Wadget], and Boff, The  -- Sturgeon, Theodore
  397. Abyss  -- Wilhelm, Kate
  398. Aces Abroad  -- Martin, George R. R.
  399. After Armageddon  -- Pournelle, J. E.
  400. After the Fact  -- Saberhagen, Fred
  401.  
  402. Report Format 2  ---------------------------------------- 
  403.  
  404.  
  405. Aldiss, Brian W.
  406.   Saliva Tree, The 
  407.  
  408. Allen, Roger MacBride
  409.   Torch of Honor 
  410.  
  411. Anderson, Poul
  412.   Circus of Hells, A 
  413.   Cold Victory 
  414.   Earthman's Burden (w/ Dickson, Gordon )
  415.   Explorations 
  416.   Hoka (w/ Dickson, Gordon )
  417.   Orbit Unlimited 
  418.   Past Times 
  419.  
  420.       > NOTES:
  421.       >
  422.       > Secondary authors are listed.
  423.       >
  424.  
  425. Report Format 3  ---------------------------------------- 
  426.  
  427.  
  428. Baen, Jim
  429.      New Destinies, Vol. IV (Winter 1988) (ED) 
  430.      New Destinies, Vol. VII (Spring 1989) (ED) 
  431.      New Destinies, Vol. VIII (Fall, 1989) (ED) 
  432.  
  433. Leemon, Sheldon
  434.  
  435.    Series:  Compute!'s Technical Reference Guide
  436.      1. Atari ST Volume One: The VDI 
  437.  
  438. Leiber, Fritz
  439.      Best of Fritz Leiber, The 
  440.      Ship of Shadows 
  441.        --Tor Double #5; w/ Anderson, Poul 'No Truce with Kings'
  442.        --This is the second comment line.
  443.      Silver Eggheads, The 
  444.  
  445.    Series:  Fafhrd and the Gray Mouser
  446.      7. Knight and Knave of Swords, The 
  447.  
  448. Leinster, Murray
  449.  
  450.    Series:  Med Series, The  (Combined Edition)
  451.      1. Mutant Weapon, The 
  452.      2. S.O.S. from Three Worlds 
  453.      3. This World is Taboo 
  454.  
  455. Lilly, John C.
  456.      Scientist, The 
  457.  
  458. Niven, Larry
  459.      Shape of Space, The 
  460.  
  461.    Series:  Dream Park
  462.      2. Barsoom Project, The (w/ Barnes, Steven )
  463.  
  464.    Series:  Man-Kzin Wars, The
  465.      1. Man-Kzin Wars, The (w/ Anderson, Poul & Ing, Dean )
  466.  
  467.  
  468.       >
  469.       > NOTES:
  470.       >
  471.       > Multiple series are sorted by series name.
  472.       > Comments are included (see double novel reference).
  473.       > 'Med Series' is a single volume with three records.
  474.       > Secondary author(s) are listed.
  475.       > Title is followed by (ED) for editor.
  476.  
  477.